Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation using DocumenterVitepress.jl #129

Merged
merged 23 commits into from
Apr 9, 2024

Conversation

camilogarciabotero
Copy link
Member

Hi all,

There has been a lot of hype in different packages of the Julia ecosystem that are migrating to DocumenterVitepress.jl, so we don't want to get behind. This is how the new docs looks when I build locally:

image

It might need some tweaks, but hopefully, we also want to migrate.

Best.

@kdpsingh
Copy link
Member

kdpsingh commented Apr 8, 2024

This looks amazing!!! Thank you thank you thank you for your work and creativity on this.

The only thing I want to tweak from the default template is the code font. While I love the look of the ligatures, I feel that they can be confusing to beginners.

I'll play with this to see if I can fix the CI test failures for the documentation build. I think I know what's happening.

@camilogarciabotero
Copy link
Member Author

I am glad you liked it. Thank you for your effort on pushing this ecosystem!

Agree, ligatures could be confusing to beginners. I used the DimensionalData.jl CSS, but definitely, it could be more original and friendly.

I believe the CI failures are due to the activation of the docs Project.toml on the main branch. I tried to play with the action, but couldn't correctly assign the activation to this PR's new env.

@kdpsingh
Copy link
Member

kdpsingh commented Apr 8, 2024

Let me explore and take a look at it locally. Excited to dig in!

@camilogarciabotero
Copy link
Member Author

I made some updates to the style to be more consistent with the logo. Also correct some broken links.

Screenshot 2024-04-08 at 8 13 33 PM

I also can confirm that no ligatures are being applied:

Screenshot 2024-04-08 at 8 14 44 PM

@kdpsingh
Copy link
Member

kdpsingh commented Apr 9, 2024

I liked the gradient on the title and the shine to the logo!!! Can we get those back?

It gave it a bit of a magical look, which I love.

@camilogarciabotero
Copy link
Member Author

Done!

@kdpsingh
Copy link
Member

kdpsingh commented Apr 9, 2024

We are fixing up some of the base packages so that Tidier will build correctly. Once that is fixed, we should be able to merge this.

@kdpsingh kdpsingh merged commit f66b5c1 into TidierOrg:main Apr 9, 2024
3 checks passed
@camilogarciabotero
Copy link
Member Author

Cool 🎉 🎉 🎉 ! Thanks for following this PR!

I have a couple of thoughts for the docs, I am willing to improve:

  1. Bring a new tab section called Articles (and let this for more through analyses)
  2. Add TiderDB with the new logo.
  3. Add another document in the Get Started section to include a short use case for TiderPlots.jl

We can transfer this to an issue.

Best.

@kdpsingh
Copy link
Member

kdpsingh commented Apr 9, 2024

@JuliaRegistrator register

@TidierOrg TidierOrg deleted a comment from JuliaRegistrator Apr 9, 2024
@camilogarciabotero camilogarciabotero mentioned this pull request Apr 9, 2024
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants